Skip to content

docs: add missing JWT_REFRESH_SECRET to backend environment variables reference table - #34

Open
Mohit-001-hash wants to merge 1 commit into
Parvaggarwal01:mainfrom
Mohit-001-hash:fix-backend-env-docs
Open

docs: add missing JWT_REFRESH_SECRET to backend environment variables reference table#34
Mohit-001-hash wants to merge 1 commit into
Parvaggarwal01:mainfrom
Mohit-001-hash:fix-backend-env-docs

Conversation

@Mohit-001-hash

@Mohit-001-hash Mohit-001-hash commented Jun 22, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown

What Changed

  • Updated the local setup instructions in README.md to include the --build flag for the docker-compose up command.
  • Added a brief note explaining why building is necessary when modifying .env files for the first time.

Why

  • Previously, the instructions simply said to run docker-compose up. If a new contributor modified their environment variables during the initial setup, those changes wouldn't be reflected in the container, leading to confusing connection errors and wasted debugging time. This ensures a smooth onboarding experience.

How To Test

  • Read the updated "Docker Setup" section in the README.md.
  • Verify the command docker-compose up -d --build is clearly documented.

Screenshots

None

Related Issue

Closes #None

Checklist

  • I have read CONTRIBUTING.md.
  • I kept this pull request focused on one issue.
  • I ran the relevant checks locally.
  • I added or updated tests where appropriate.
  • I added screenshots or screen recordings for UI changes.
  • I documented any known limitations or follow-up work.

Notes

None

Summary by CodeRabbit

  • Documentation
    • Updated backend environment variables documentation to include JWT refresh secret configuration reference.

@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown

@Mohit-001-hash is attempting to deploy a commit to the Parv Aggarwal's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 11204b41-665c-4a25-a793-e71835594135

📥 Commits

Reviewing files that changed from the base of the PR and between f2501a5 and 5b04dbd.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

A single row documenting JWT_REFRESH_SECRET (example value: your_refresh_secret) was added to the Backend (.env) environment variables table in README.md.

Changes

README Documentation Update

Layer / File(s) Summary
Add JWT_REFRESH_SECRET to env vars table
README.md		 Inserts a new row for JWT_REFRESH_SECRET with its example value into the Backend (.env) environment variables table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A secret for tokens, now listed with care,
The refresh key hidden no longer — it's there!
One row in a table, a small fluffy hop,
The docs are now whole, right up to the top.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add missing JWT_REFRESH_SECRET to backend environment variables reference table' directly matches the raw summary which confirms adding JWT_REFRESH_SECRET to the backend environment variables table in README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Mohit-001-hash